Formatting Showcase

This page demonstrates every formatting feature supported by Obsidiosaurus v1.2.0.

---

Text Formatting

Bold text — **text**

Italic text — *text* or _text_

Bold and italic — ***text***

Strikethrough — ~~text~~

Highlighting: Highlighted text — syntax <mark>text</mark> (converted to <mark>)

Inline code — `code`

---

Headings

H1 — Document Title

H2 — Section

H3 — Subsection

H4 — Detail

H5 — Fine detail

H6 — Finest level

---

Links

External link

[[formatting_showcase__en|Internal Obsidian link]]

---

Lists

Unordered

• Item A
• Item B
  • Nested item
  • Another nested
    • Third level
• Item C

Ordered

1. First
2. Second
   1. Nested ordered
   2. Another
3. Third

Task list

• Open task
• Completed task
• Another open task

---

Blockquote

This is a standard blockquote. It can span multiple lines.

---

Callouts / Admonitions

Note

General information worth highlighting.

Tip

A helpful hint or best practice.

Info

Additional background context.

Warning

Something the user should be cautious about.

Danger

A critical warning — potential for data loss or breaking changes.

Caution

Proceed carefully.

"The best documentation is the one that gets written."

— Quote

---

Tables

Feature	Obsidian	Docusaurus	Status
Bold / Italic	✅	✅	Native
Highlighting	✅	✅	Converted
Mermaid	✅	✅	Plugin
Comments	✅	filtered	Removed
Footnotes	✅	✅	Native
Tasks	✅	✅	Native

---

Code Blocks

Inline

Use npm run build to build the project.

Block (with syntax highlighting)

function greet(name: string): string {
  return `Hello, ${name}!`;
}

console.log(greet("Obsidiosaurus"));

def convert_markdown(source: str) -> str:
    """Convert Obsidian markdown to Docusaurus format."""
    return source.replace("==", "<mark>")

# Run Obsidiosaurus conversion
npx obsidiosaurus convert --vault ./vault --output ./website

---

Diagrams (Mermaid)

Requires @docusaurus/theme-mermaid — configured in docusaurus.config.js:

themes: ['@docusaurus/theme-mermaid'],
markdown: { mermaid: true }

Flowchart

flowchart TD
    A[Obsidian Vault] --> B{Obsidiosaurus}
    B --> C[Docusaurus MDX]
    C --> D[Static Website]
    B --> E[Assets]
    E --> D

Sequence Diagram

sequenceDiagram
    participant User
    participant Obsidian
    participant Obsidiosaurus
    participant Docusaurus

    User->>Obsidian: Edit note
    User->>Obsidiosaurus: Click convert button
    Obsidiosaurus->>Obsidian: Read vault files
    Obsidiosaurus->>Docusaurus: Write converted MDX
    Docusaurus-->>User: Rendered website

Class Diagram

classDiagram
    class MarkdownProcessor {
        +convertHighlighting(text) string
        +filterComments(text) string
        +convertAdmonitions(text) string
    }
    class AssetProcessor {
        +copyAssets(source, target)
        +resizeImage(path, width)
    }
    class MainProcessor {
        +process(basePath)
    }
    MainProcessor --> MarkdownProcessor
    MainProcessor --> AssetProcessor

Gantt Chart

gantt
    title Obsidiosaurus v1.x Roadmap
    dateFormat  YYYY-MM-DD
    section v1.0.0
    Modernization           :done, 2026-04-10, 2026-04-11
    section v1.1.0
    Comment filter          :done, 2026-04-12, 1d
    Highlighting support    :done, 2026-04-12, 1d
    Mermaid support         :done, 2026-04-12, 1d
    section v1.2.0
    REST API agent trigger  :done, 2026-05-16, 1d
    Headless conversion     :done, 2026-05-16, 1d
    Status file polling     :done, 2026-05-16, 1d

Pie Chart

pie title Obsidiosaurus Feature Coverage
    "Implemented" : 85
    "Planned" : 10
    "Not supported" : 5

---

Math Equations

Inline math: $E = mc^2$

Block equation:

$$\int_{-\infty}^{\infty} e^{-x^2} dx = \sqrt{\pi}$$ $$\frac{\partial f}{\partial x} = \lim_{h \to 0} \frac{f(x+h) - f(x)}{h}$$

---

Footnotes

Obsidiosaurus supports standard markdown footnotes.¹

They render natively in Docusaurus MDX.²

---

Horizontal Rules

Content above

---

Content below

---

Comments (Obsidian-only)

Comments are written with `` and are removed during conversion — they never appear on the website.

Inline syntax:

Block syntax:

The text above is an inline comment in Obsidian. It is not visible here.

The text above is a block comment in Obsidian. It is also not visible here.

---

Images

Obsidiosaurus converts images to .webp and handles resizing automatically.

Standard image

![[obsidiosaurus_sidebar_icon.png]]

Resized image (400px width)

![[obsidiosaurus_run_sucess_notifaction_2.png|400]]

---

iFrames

Embed external content directly:

Footnotes

1. Footnotes appear at the bottom of the page automatically. ↩

2. No special conversion needed — MDX handles them out of the box. ↩